docs(security): add SECURITY.md and a private reporting channel - #298
Merged
Conversation
keel holds exchange credentials and places live orders; once the repo is discoverable, the only routes were a public issue or silence (#279). SECURITY.md names the private channel (GitHub private vulnerability reporting, now enabled in repo settings), an honest solo-maintainer SLA, and the scope: a bypassable rail is a security issue, not merely a bug. tests/test_security_policy.py pins all of it.
This was referenced Aug 16, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #279
keel holds exchange API credentials and places live orders. Once strangers read the source,
someone will eventually find a way to make it misbehave — and until now the only options were
a public issue (disclosing to everyone simultaneously) or nothing.
What
SECURITY.mdat the repo root:vulnerability button under the Security tab. Enabled in repo settings (verified:
gh api .../private-vulnerability-reporting→{"enabled":true}); the file alone givesno channel, per the issue's note.
merely a bug (allowlist, caps, drawdown breakers, kill-switch), credential/secret
exposure, and corruption of the attestation/audit trail.
exchange's own outages.
severity + plan within 14, coordinated disclosure, credit by default.
tests/test_security_policy.py(written first, red, then green): pins the channel, theday-count commitment, the rail-bypass scope line, and the out-of-scope list. The
GitHub-side setting is outside the tree and was verified against the live repo instead.
Gates (rebased on main after #297):
pytest2782 passed / 1 skipped,ruff checkclean,mypyclean.